/**
 * Software License, Version 1.0
 * 
 * Copyright 2003 The Trustees of Indiana University.  All rights reserved.
 * 
 *
 *Redistribution and use in source and binary forms, with or without 
 *modification, are permitted provided that the following conditions are met:
 *
 *1) All redistributions of source code must retain the above copyright notice,
 * the list of authors in the original source code, this list of conditions and
 * the disclaimer listed in this license;
 *2) All redistributions in binary form must reproduce the above copyright 
 * notice, this list of conditions and the disclaimer listed in this license in
 * the documentation and/or other materials provided with the distribution;
 *3) Any documentation included with all redistributions must include the 
 * following acknowledgement:
 *
 *"This product includes software developed by the Community Grids Lab. For 
 * further information contact the Community Grids Lab at 
 * http://communitygrids.iu.edu/."
 *
 * Alternatively, this acknowledgement may appear in the software itself, and 
 * wherever such third-party acknowledgments normally appear.
 * 
 *4) The name Indiana University or Community Grids Lab or NaradaBrokering, 
 * shall not be used to endorse or promote products derived from this software 
 * without prior written permission from Indiana University.  For written 
 * permission, please contact the Advanced Research and Technology Institute 
 * ("ARTI") at 351 West 10th Street, Indianapolis, Indiana 46202.
 *5) Products derived from this software may not be called NaradaBrokering, 
 * nor may Indiana University or Community Grids Lab or NaradaBrokering appear
 * in their name, without prior written permission of ARTI.
 * 
 *
 * Indiana University provides no reassurances that the source code provided 
 * does not infringe the patent or any other intellectual property rights of 
 * any other entity.  Indiana University disclaims any liability to any 
 * recipient for claims brought by any other entity based on infringement of 
 * intellectual property rights or otherwise.  
 *
 *LICENSEE UNDERSTANDS THAT SOFTWARE IS PROVIDED "AS IS" FOR WHICH NO 
 *WARRANTIES AS TO CAPABILITIES OR ACCURACY ARE MADE. INDIANA UNIVERSITY GIVES
 *NO WARRANTIES AND MAKES NO REPRESENTATION THAT SOFTWARE IS FREE OF 
 *INFRINGEMENT OF THIRD PARTY PATENT, COPYRIGHT, OR OTHER PROPRIETARY RIGHTS. 
 *INDIANA UNIVERSITY MAKES NO WARRANTIES THAT SOFTWARE IS FREE FROM "BUGS", 
 *"VIRUSES", "TROJAN HORSES", "TRAP DOORS", "WORMS", OR OTHER HARMFUL CODE.  
 *LICENSEE ASSUMES THE ENTIRE RISK AS TO THE PERFORMANCE OF SOFTWARE AND/OR 
 *ASSOCIATED MATERIALS, AND TO THE PERFORMANCE AND VALIDITY OF INFORMATION 
 *GENERATED USING SOFTWARE.
 */
package cgl.narada.wsinfra.wse;

import cgl.narada.wsinfra.exception.WsFaultException;
import cgl.narada.wsinfra.schemas.addressing.EndpointReferenceType;
import cgl.narada.wsinfra.schemas.eventing.GetStatusDocument;
import cgl.narada.wsinfra.schemas.eventing.GetStatusResponseDocument;
import cgl.narada.wsinfra.schemas.eventing.IdentifierDocument;
import cgl.narada.wsinfra.schemas.eventing.RenewDocument;
import cgl.narada.wsinfra.schemas.eventing.RenewResponseDocument;
import cgl.narada.wsinfra.schemas.eventing.SubscribeDocument;
import cgl.narada.wsinfra.schemas.eventing.SubscribeResponseDocument;
import cgl.narada.wsinfra.schemas.eventing.SubscriptionEndDocument;
import cgl.narada.wsinfra.schemas.eventing.UnsubscribeDocument;
import cgl.narada.wsinfra.schemas.soap.EnvelopeDocument;
import cgl.narada.wsinfra.wse.impl.WseNodeUtilsImpl;
/**
   A utility class which retrieves various elements that are relevant to
   WS-Eventing. The method class will also throw relevant exceptions if
   it encounters problems in locating content.

   @author Shrideep Pallickara
   $Date: 2005/07/29 22:41:30 $
   $Revision: 1.6 $
*/

public abstract class WseNodeUtils {

  public static WseNodeUtils getInstance() {
    return WseNodeUtilsImpl.getInstance();
  }

  /** This method retrieves the SubscribeDocument element from the BODY of
      the SOAP envelope. The method has to throw exceptions, if either the
      element is null or is not present. */
  public abstract SubscribeDocument
  getSubscribeDocument(EnvelopeDocument envelopeDocument)
    throws WsFaultException;


  /** This method retrieves the SubscribeResponseDocument element from the
      BODY of the SOAP envelope. The method has to throw exceptions, if either
      the element is null or is not present. */
  public abstract SubscribeResponseDocument
  getSubscribeResponseDocument(EnvelopeDocument envelopeDocument)
    throws WsFaultException;




  /** This method retrieves the RenewDocument element from the BODY of
      the SOAP envelope. The method has to throw exceptions, if either the
      element is null or is not present. */
  public abstract RenewDocument
  getRenewDocument(EnvelopeDocument envelopeDocument)
    throws WsFaultException;



  /** This method retrieves the RenewResponseDocument element from the
      BODY of the SOAP envelope. The method has to throw exceptions, if either
      the element is null or is not present. */
  public abstract RenewResponseDocument
  getRenewResponseDocument(EnvelopeDocument envelopeDocument)
    throws WsFaultException;



  /** This method retrieves the GetStatusDocument element from the BODY of
      the SOAP envelope. The method has to throw exceptions, if either the
      element is null or is not present. */
  public abstract GetStatusDocument
  getGetStatusDocument(EnvelopeDocument envelopeDocument)
    throws WsFaultException;



  /** This method retrieves the GetStatusResponseDocument element from the
      BODY of the SOAP envelope. The method has to throw exceptions, if either
      the element is null or is not present. */
  public abstract GetStatusResponseDocument
  getGetStatusResponseDocument(EnvelopeDocument envelopeDocument)
    throws WsFaultException;




  /** This method retrieves the UnsubscribeDocument element from the BODY of
      the SOAP envelope. The method has to throw exceptions, if either the
      element is null or is not present. */
  public abstract UnsubscribeDocument
  getUnsubscribeDocument(EnvelopeDocument envelopeDocument)
    throws WsFaultException;





  /** This method retrieves the SubscriptionEndDocument element from the BODY
      of the SOAP envelope. The method has to throw exceptions, if either the
      element is null or is not present. */
  public abstract SubscriptionEndDocument
  getSubscriptionEndDocument(EnvelopeDocument envelopeDocument)
    throws WsFaultException;



  /** This method retrieves the identifier element from the HEADER of the
      SOAP envelope. The method has to throw exceptions, if either the element
      is null or is not present. */
  public abstract IdentifierDocument
  getIdentifierDocument(EnvelopeDocument envelopeDocument)
    throws WsFaultException;


  /** This method retrieves the identifier element from the HEADER of the
      SOAP envelope. The method has to throw exceptions, if either the element
      is null or is not present. */
  public abstract IdentifierDocument
  getIdentifierDocumentFromBody(EnvelopeDocument envelopeDocument)
    throws WsFaultException;

  
  /** This method tries to retrieve the notifyTo element. The method also
      issues exception in case it is unable to do so or if the retrived
      element is actually null */
  public abstract EndpointReferenceType 
  getNotifyTo(SubscribeDocument subscribeDocument)
    throws WsFaultException;

}
